<meta charset="utf-8">
(#) Unsupported View in RemoteView

!!! ERROR: Unsupported View in RemoteView
   This is an error.

Id
:   `RemoteViewLayout`
Summary
:   Unsupported View in RemoteView
Severity
:   Error
Category
:   Correctness
Platform
:   Android
Vendor
:   Android Open Source Project
Feedback
:   https://issuetracker.google.com/issues/new?component=192708
Since
:   4.2.0 (May 2021)
Affects
:   Kotlin and Java files
Editing
:   This check runs on the fly in the IDE editor
See
:   https://developer.android.com/reference/android/widget/RemoteViews
Implementation
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/RemoteViewDetector.kt)
Tests
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/RemoteViewDetectorTest.kt)

In a `RemoteView`, only some layouts and views are allowed.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/test/pkg/test.kt:5:Error: @layout/test includes views not allowed in
a RemoteView: CheckBox, DatePicker, RadioButton, RadioGroup, Switch,
androidx.appcompat.widget.AppCompatTextView [RemoteViewLayout]
    val remoteView = RemoteViews(packageName, R.layout.test)
                     ---------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here are the relevant source files:

`src/test/pkg/test.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package test.pkg
import android.widget.RemoteViews

fun test(packageName: String) {
    val remoteView = RemoteViews(packageName, R.layout.test)
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`res/layout/test.xml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
&lt;merge&gt;
    &lt;Button /&gt;
    &lt;AdapterViewFlipper /&gt;
    &lt;FrameLayout /&gt;
    &lt;GridLayout /&gt;
    &lt;GridView /&gt;
    &lt;LinearLayout /&gt;
    &lt;ListView /&gt;
    &lt;RelativeLayout /&gt;
    &lt;StackView /&gt;
    &lt;ViewFlipper /&gt;
    &lt;AnalogClock /&gt;
    &lt;Button /&gt;
    &lt;Chronometer /&gt;
    &lt;ImageButton /&gt;
    &lt;ImageView /&gt;
    &lt;ProgressBar /&gt;
    &lt;TextClock /&gt;
    &lt;TextView /&gt;
    &lt;DatePicker /&gt;
    &lt;CheckBox /&gt;
    &lt;Switch /&gt;
    &lt;RadioButton /&gt;
    &lt;RadioGroup /&gt;
    &lt;androidx.appcompat.widget.AppCompatTextView /&gt;
&lt;/merge&gt;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`test.pkg`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text linenumbers
@layout/test
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/RemoteViewDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("RemoteViewLayout")
  fun method() {
     RemoteViews(...)
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("RemoteViewLayout")
  void method() {
     new RemoteViews(...);
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection RemoteViewLayout
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="RemoteViewLayout" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'RemoteViewLayout'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore RemoteViewLayout ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>